Get job balance

Path: api/v1/accounts/debtors/jobbalance/{jobno}

This endpoint supports the following methods:
GET

Summary: Returns original amount, balance due and currency code of job

NoteIf the job has already been invoiced, a 400 (Bad Request) is returned with the invoice number (invNo) and no balance. Retrieve the balance from the /accounts/debtors/invoicebalance/{invNo} endpoint instead.

Description: Applies only to jobs that have not yet been invoiced.

Response content

Attribute	Type	Description
amount	number	The job total amount
balanceDue	number	The balance due amount for the job (job total minus prepayments for the job)
currencyCode	string	The currency code of the job
invNo	integer	Always null on a successful response. An invoiced job returns a 400 (Bad Request) instead of a balance.
jobNo	integer	Job number

Example GET

Path: api/v1/accounts/debtors/jobbalance/10

Response:

This example shows the maximum set of fields the endpoint can return, all populated. A real response only contains the data that applies to that record, so fields that are empty or not relevant are omitted — do not assume every field shown here will be present in every response.

{
    "jobNo": 2026131,
    "invNo": null,
    "amount": 3063.8100,
    "balanceDue": 0.0200,
    "currencyCode": "AUD"
}